1.1 查询在线用户

基本信息

Path: /api/v1/monitor/getUserStatus

Method: GET

接口描述:

  1. 默认只展示在线用户的数据,实时在线数据接口由SDP-C提供。

请求参数

Query

参数名称 是否必须 示例 备注
pageSize 必须 10 每页的大小 默认20
pageIndex 必须 1 当前页 默认1 从1开始
filter 非必须 name 过滤条件,可选值:all(所有条件)、name(用户名)、displayName(显示名)、userDirectoryName(所属用户目录)、groupPath(所属组织架构)、remoteIp(接入IP)、vip(虚拟IP)、os(操作系统类型)、browser(接入方式)
searchValue 非必须 张三 过滤搜索值
sortBy 非必须 name 排序字段,可选值:name(用户名)、groupPath(所属组织架构)、browser(接入方式)、os(操作系统类型)、 lastLoginTime(最后登录时间)、authTypeList(认证方式)、 remoteIp(接入IP)、 userDirectoryName(所属用户目录)、vip(虚拟IP)
asc 非必须 1 是否升序:1为升序、0为降序(不传默认为降序)

请求示例

pageSize=20&pageIndex=1&searchValue=张三

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,0代表成功 示例:0
data object 必须 返回数据
├─ count number 必须 返回的数组元素总数
├─ amount number 必须 在线用户数
├─ onlineUser number 必须 基于账号去重后的在线用户数
├─ pageSize string 必须 分页大小
├─ pageIndex string 必须 当前页
├─ data object[] 必须 用户状态列表
├─ ├─ id string 必须 记录ID
├─ ├─ name string 必须 用户名称
├─ ├─ displayName string 必须 显示名
├─ ├─ userDirectoryName string 必须 用户目录名
├─ ├─ groupPath string 必须 所属组织架构路径
├─ ├─ os string 必须 操作系统信息
├─ ├─ browser string 必须 接入方式
├─ ├─ remoteIp string 必须 接入IP
├─ ├─ remoteIpLocation string 必须 IP归属地 2.2.10SP5以及2.2.16及以后版本支持此字段
├─ ├─ authTypeList object[] 必须 认证类型列表
├─ ├─ lastLoginTime string 必须 最后登录时间
├─ ├─ userId string 必须 用户ID
├─ ├─ domain string 必须 登录域
├─ ├─ vips object[] 非必须 虚拟IP列表
├─ ├─├─ ip string 非必须 虚拟IP
├─ ├─├─ proxyClientId string 非必须 节点ID
├─ ├─├─ proxyClientName string 非必须 节点名称
msg string 必须 描述信息 示例:成功

返回示例

{
    "code": 0,
    "data": {
        "data": [
            {
                "id": "33100014",
                "name": "张三",
                "groupPath": "/",
                "os": "Windows 10",
                "browser": "Chrome/104.0.5112.102",
                "remoteIp": "175.9.142.2",
                "remoteIpLocation":"内网IP",
                "lastLoginTime": "2022-09-29 16:04:33",
                "domain": "local",
                "userId": "9f8146c0-8aeb-11ec-b30f-e50f6db6d9d6",
                "userDirectoryName": "本地用户目录",
                "isTrusted": 0,
                "displayName": "显示名"
            }
        ],
        "count": 1,
        "pageSize": 20,
        "pageIndex": 1,
        "amount": 1,
        "onlineUser": 1
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
不支持的搜索内容 7201
不支持的排序内容 7201
不支持的排序方式 7201
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-07-22 20:13

results matching ""

    No results matching ""